ProfileFiles
The files a well-kept repository carries, each present or absent.
Shape
catalogProfileFile or nulloptional
- The ProfileFile schema
- pathstring
changelogProfileFile or nulloptional
- The ProfileFile schema
- pathstring
code_of_conductProfileFile or nulloptional
- The ProfileFile schema
- pathstring
codeownersProfileFile or nulloptional
- The ProfileFile schema
- pathstring
contributingProfileFile or nulloptional
- The ProfileFile schema
- pathstring
licenseProfileLicense or nulloptional
- The ProfileLicense schema
- pathstring
- namestring or nulloptional
- spdx_idstring or nulloptionalThe licence's SPDX identifier, when the text is one of the licences the platform knows. Absent for a licence it does not recognise — never a guess at the nearest.
readmeProfileFile or nulloptional
- The ProfileFile schema
- pathstring
securityProfileFile or nulloptional
- The ProfileFile schema
- pathstring
Example
Synthesized example{
"catalog": {
"path": "path-bffa"
},
"changelog": {
"path": "path-4a5f"
},
"code_of_conduct": {
"path": "path-4d38"
},
"codeowners": {
"path": "path-853f"
},
"contributing": {
"path": "path-5cd2"
},
"license": {
"path": "path-7527",
"name": "payments-api",
"spdx_id": "678274dd-a43a-42a1-bf5d-005740493945"
},
"readme": {
"path": "path-64b5"
},
"security": {
"path": "path-95dc"
}
}
Graph
Used inside
Contains
Used by
Sent by 0 operations
No operation takes it as a request body.
Returned by 0 operations
No operation returns it directly.