Skip to content

[ENG-11427] 1.9.1 BE: Update API documentation#85

Open
mkovalua wants to merge 1 commit into
CenterForOpenScience:masterfrom
mkovalua:feature/ENG-11427
Open

[ENG-11427] 1.9.1 BE: Update API documentation#85
mkovalua wants to merge 1 commit into
CenterForOpenScience:masterfrom
mkovalua:feature/ENG-11427

Conversation

@mkovalua

@mkovalua mkovalua commented Jul 24, 2026

Copy link
Copy Markdown

https://openscience.atlassian.net/browse/ENG-11427

Update API docs to reflect limits on project updating

Collection submissions

node metadata updating

node contributors updating

node wiki updating
TODO: fill out rest

Documents the 405 Method Not Allowed behavior added when the PROJECT_READ_ONLY waffle flag is active, which blocks write access to a node and its related resources.

API docs changings are related to the PRs

https://github.com/futa-ikeda/osf.io/pulls?q=is%3Apr+is%3Aclosed

| YAML file (HTTP) | Source PR(s) | PR title | Permission class |

| nodes/detail.yaml (PATCH) | Make new permission class for when project editing is not allowed / ENG-11400 Prevent updates to node metadata via API | ProjectEditingNotAllowed |

| collections/collected_metadata_list.yaml (POST) | ENG-11397: Prevent collection submissions via API when project_read_only flag is active | CollectionSubmissionsNotAllowed |

| custom_metadata/nodes_list.yaml (PATCH) | ENG-11403 Prevent updates to node resource and funder information via API | ItemMetadataEditingNotAllowed |

| cedar_metadata/nodes_list.yaml (POST) | [ENG-11414] Prevent creation and edit of community metadata records via API | CedarMetadataRecordsNotAllowed |

| cedar_metadata/files_list.yaml (POST) | [ENG-11414] Prevent creation and edit of community metadata records via API | CedarMetadataRecordsNotAllowed |

| nodes/contributors_list.yaml (POST) | 1.3.6 BE: Prevent updates to node contributors via API | NodeContributorWriteNotAllowed |

| nodes/contributor_detail.yaml (PATCH, DELETE) | 1.3.6 BE: Prevent updates to node contributors via API | NodeContributorWriteNotAllowed |

| wikis/versions_list.yaml (POST) | [ENG-11395] Prevent project wiki updates via API | WikisEditingNotAllowed |

| nodes/relationships_subjects_list.yaml (PATCH, POST, DELETE) | [ENG-11401] Prevent node subject updates via API based on project_read_only flag / 1.3.15 BE: Add new Permission class for node relationships | ProjectEditingNotAllowed -> ProjectRelationshipsEditingNotAllowed |

| nodes/identifiers_list.yaml (POST) | 1.3.3 BE: Prevent updates to node identifiers via API | NodeIdentifierCreationNotAllowed |

| nodes/relationships_institutions_list.yaml (PATCH, POST, DELETE) | 1.3.5 BE: Prevent updates to node affiliation information via API / 1.3.15 BE: Add new Permission class for node relationships | NodeAffiliationWriteNotAllowed -> ProjectRelationshipsEditingNotAllowed |

| nodes/relationships_linked_nodes_list.yaml` (PATCH, POST, DELETE) | 1.3.7 BE: Prevent updates to node Linked Projects/Registrations via API / 1.3.15 BE: Add new Permission class for node relationships | NodeLinkedWriteNotAllowed -> ProjectRelationshipsEditingNotAllowed |

| nodes/relationships_linked_registrations_list.yaml (PATCH, POST, DELETE) | 1.3.7 BE: Prevent updates to node Linked Projects/Registrations via API / 1.3.15 BE: Add new Permission class for node relationships | NodeLinkedWriteNotAllowed -> ProjectRelationshipsEditingNotAllowed |

| nodes/node_settings_list.yaml (PATCH) | Feature/project settings | ProjectEditingNotAllowed |

| nodes/draft_registrations_list.yaml (POST) | 1.5.1 BE: Prevent registrations based on projects | NodeDraftRegistrationCreationNotAllowed |

Maybe it is needed to have another one target branch

@mkovalua
mkovalua force-pushed the feature/ENG-11427 branch from c10b7fe to 95ca75d Compare July 24, 2026 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant