Skip to content

Commit

Permalink
Update docs regarding rust_version in the publish API
Browse files Browse the repository at this point in the history
  • Loading branch information
cassaundra committed Apr 26, 2023
1 parent 5554889 commit c83f7bb
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 2 additions & 3 deletions src/doc/src/reference/registry-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,9 +224,8 @@ The JSON objects should not be modified after they are added except for the
> * The publish API includes several other fields, such as `description` and `readme`, which don't appear in the index.
> These are intended to make it easier for a registry to obtain the metadata about the crate to display on a website without needing to extract and parse the `.crate` file.
> This additional information is typically added to a database on the registry server.
> * `rust_version` is not included. If a registry chooses to support this
> field, they must read it from the `Cargo.toml` contained in the `.crate`
> file.
> * Although `rust_version` is included here, [crates.io] will ignore this field
> and instead read it from the `Cargo.toml` contained in the `.crate` file.
>
> For [`cargo metadata`], the differences are:
>
Expand Down
5 changes: 4 additions & 1 deletion src/doc/src/reference/registry-web-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,10 @@ considered as an exhaustive list of restrictions [crates.io] imposes.
},
// The `links` string value from the package's manifest, or null if not
// specified. This field is optional and defaults to null.
"links": null
"links": null,
// The minimal supported Rust version (optional)
// This must be a valid version requirement without an operator (e.g. no `=`)
"rust_version": null
}
```

Expand Down

0 comments on commit c83f7bb

Please sign in to comment.