From 184990e1c256a4bd4d990092b4ce37ed7400d084 Mon Sep 17 00:00:00 2001 From: Konstantin Babushkin Date: Tue, 12 Dec 2023 12:00:23 +0100 Subject: [PATCH] Restore read the docs (#371) * add readthedocs.yaml * remove button * move to python 3 --- .readthedocs.yaml | 22 +++++++++++++++++ doc/.gitignore | 1 + doc/_exts/samples.py | 12 ++-------- doc/requirements.txt | 2 +- doc/services/identity/v3/credentials.rst | 10 ++++---- doc/services/identity/v3/domains.rst | 26 ++++++++++----------- doc/services/identity/v3/endpoints.rst | 10 ++++---- doc/services/identity/v3/groups.rst | 18 +++++++------- doc/services/identity/v3/projects.rst | 26 ++++++++++----------- doc/services/identity/v3/roles.rst | 6 ++--- doc/services/identity/v3/services.rst | 8 +++---- doc/services/identity/v3/tokens.rst | 18 +++++++------- doc/services/identity/v3/users.rst | 14 +++++------ doc/services/object-store/v1/account.rst | 8 +++---- doc/services/object-store/v1/containers.rst | 12 +++++----- doc/services/object-store/v1/objects.rst | 22 ++++++++--------- 16 files changed, 115 insertions(+), 100 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..5775c3f63 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +# Build documentation in the "doc/" directory with Sphinx +sphinx: + configuration: doc/conf.py + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: doc/requirements.txt \ No newline at end of file diff --git a/doc/.gitignore b/doc/.gitignore index 33ce14771..363a33352 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,2 +1,3 @@ +.idea/ _build/ api-docs/build diff --git a/doc/_exts/samples.py b/doc/_exts/samples.py index 5daa1f9a3..bb11d3ebf 100644 --- a/doc/_exts/samples.py +++ b/doc/_exts/samples.py @@ -1,7 +1,6 @@ -from sphinx.directives import LiteralInclude from docutils import nodes from sphinx.addnodes import download_reference -from sphinx.writers.html import HTMLTranslator +from sphinx.directives.code import LiteralInclude import re class Sample(LiteralInclude): @@ -10,7 +9,7 @@ def run(self): self.arguments[0] = "/../samples/" + self.arguments[0] self.options['language'] = 'php' - pattern = "[\s+]?(\<\?php.*?]\);)" + pattern = r"[\s+]?(\<\?php.*?]\);)" code_block = super(Sample, self).run()[0] string = str(code_block[0]) @@ -29,13 +28,6 @@ def run(self): nodes.literal_block(auth_str, auth_str, language="php"), nodes.literal_block(main_str, main_str, language="php")] -def visit_download_reference(self, node): - self.context.append('Show auth code') - -def depart_download_reference(self, node): - self.body.append(self.context.pop()) - def setup(app): - app.add_node(download_reference, html=(visit_download_reference, depart_download_reference)) app.add_directive('sample', Sample) return {'version': '0.1'} diff --git a/doc/requirements.txt b/doc/requirements.txt index 449e06ca5..44f7df3fc 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1 +1 @@ -sphinxcontrib-phpdomain==0.1.4 +sphinxcontrib-phpdomain>=0.11.0 diff --git a/doc/services/identity/v3/credentials.rst b/doc/services/identity/v3/credentials.rst index b0cf1d849..56a1e55ea 100644 --- a/doc/services/identity/v3/credentials.rst +++ b/doc/services/identity/v3/credentials.rst @@ -7,7 +7,7 @@ Add credential Create a secret/access pair for use with ec2 style auth. This operation will generates a new set of credentials that map the user/tenant pair. -.. sample:: Identity/v2/credentials/add_cred.php +.. sample:: Identity/v3/credentials/add_cred.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_createCredential List credentials @@ -15,7 +15,7 @@ List credentials List all credentials for a given user. -.. sample:: Identity/v2/credentials/list_creds.php +.. sample:: Identity/v3/credentials/list_creds.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_listCredentials Show credential details @@ -23,13 +23,13 @@ Show credential details Retrieve a user's access/secret pair by the access key. -.. sample:: Identity/v2/credentials/get_cred.php +.. sample:: Identity/v3/credentials/get_cred.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_getCredential Update credential ----------------- -.. sample:: Identity/v2/credentials/update_cred.php +.. sample:: Identity/v3/credentials/update_cred.php .. refdoc:: OpenStack/Identity/v3/Models/Credential.html#method_update Delete credential @@ -37,5 +37,5 @@ Delete credential Delete a user's access/secret pair. -.. sample:: Identity/v2/credentials/delete_cred.php +.. sample:: Identity/v3/credentials/delete_cred.php .. refdoc:: OpenStack/Identity/v3/Models/Credential.html#method_delete diff --git a/doc/services/identity/v3/domains.rst b/doc/services/identity/v3/domains.rst index 079937e86..409059d94 100644 --- a/doc/services/identity/v3/domains.rst +++ b/doc/services/identity/v3/domains.rst @@ -4,77 +4,77 @@ Domains Add domain ---------- -.. sample:: Identity/v2/domains/add_domain.php +.. sample:: Identity/v3/domains/add_domain.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_createDomain List domains ------------ -.. sample:: Identity/v2/domains/list_domains.php +.. sample:: Identity/v3/domains/list_domains.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_listDomains Show domain details ------------------- -.. sample:: Identity/v2/domains/show_domain.php +.. sample:: Identity/v3/domains/show_domain.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_getDomain Update domain ------------- -.. sample:: Identity/v2/domains/update_domain.php +.. sample:: Identity/v3/domains/update_domain.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_update Delete domain ------------- -.. sample:: Identity/v2/domains/delete_domain.php +.. sample:: Identity/v3/domains/delete_domain.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_delete List roles for domain user -------------------------- -.. sample:: Identity/v2/domains/list_user_roles.php +.. sample:: Identity/v3/domains/list_user_roles.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_listUserRoles Grant role to domain user ------------------------- -.. sample:: Identity/v2/domains/grant_user_role.php +.. sample:: Identity/v3/domains/grant_user_role.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_grantUserRole Check role for domain user -------------------------- -.. sample:: Identity/v2/domains/check_user_role.php +.. sample:: Identity/v3/domains/check_user_role.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_checkUserRole Revoke role for domain user --------------------------- -.. sample:: Identity/v2/domains/revoke_user_role.php +.. sample:: Identity/v3/domains/revoke_user_role.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_revokeUserRole List roles for domain group --------------------------- -.. sample:: Identity/v2/domains/list_group_roles.php +.. sample:: Identity/v3/domains/list_group_roles.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_listGroupRoles Grant role to domain group -------------------------- -.. sample:: Identity/v2/domains/grant_group_role.php +.. sample:: Identity/v3/domains/grant_group_role.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_grantGroupRole Check role for domain group --------------------------- -.. sample:: Identity/v2/domains/check_group_role.php +.. sample:: Identity/v3/domains/check_group_role.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_checkGroupRole Revoke role for domain group ---------------------------- -.. sample:: Identity/v2/domains/revoke_group_role.php +.. sample:: Identity/v3/domains/revoke_group_role.php .. refdoc:: OpenStack/Identity/v3/Models/Domain.html#method_revokeGroupRole diff --git a/doc/services/identity/v3/endpoints.rst b/doc/services/identity/v3/endpoints.rst index c4aadb84a..d5d99e6af 100644 --- a/doc/services/identity/v3/endpoints.rst +++ b/doc/services/identity/v3/endpoints.rst @@ -4,29 +4,29 @@ Endpoints Add endpoints ------------- -.. sample:: Identity/v2/endpoints/add_endpoint.php +.. sample:: Identity/v3/endpoints/add_endpoint.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_createEndpoint Get endpoint ------------ -.. sample:: Identity/v2/endpoints/get_endpoint.php +.. sample:: Identity/v3/endpoints/get_endpoint.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_getEndpoint List endpoints -------------- -.. sample:: Identity/v2/endpoints/list_endpoints.php +.. sample:: Identity/v3/endpoints/list_endpoints.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_listEndpoints Update endpoint --------------- -.. sample:: Identity/v2/endpoints/update_endpoint.php +.. sample:: Identity/v3/endpoints/update_endpoint.php .. refdoc:: OpenStack/Identity/v3/Models/Endpoint.html#method_update Delete endpoint --------------- -.. sample:: Identity/v2/endpoints/delete_endpoint.php +.. sample:: Identity/v3/endpoints/delete_endpoint.php .. refdoc:: OpenStack/Identity/v3/Models/Endpoint.html#method_delete diff --git a/doc/services/identity/v3/groups.rst b/doc/services/identity/v3/groups.rst index 7a29b6725..4fc037754 100644 --- a/doc/services/identity/v3/groups.rst +++ b/doc/services/identity/v3/groups.rst @@ -4,53 +4,53 @@ Groups Add group --------- -.. sample:: Identity/v2/groups/add_group.php +.. sample:: Identity/v3/groups/add_group.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_createGroup List groups ----------- -.. sample:: Identity/v2/groups/list_groups.php +.. sample:: Identity/v3/groups/list_groups.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_listGroups Show group details ------------------ -.. sample:: Identity/v2/groups/get_group.php +.. sample:: Identity/v3/groups/get_group.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_getGroup Update group ------------ -.. sample:: Identity/v2/groups/update_group.php +.. sample:: Identity/v3/groups/update_group.php .. refdoc:: OpenStack/Identity/v3/Models/Group.html#method_update Delete group ------------ -.. sample:: Identity/v2/groups/delete_group.php +.. sample:: Identity/v3/groups/delete_group.php .. refdoc:: OpenStack/Identity/v3/Models/Group.html#method_delete List users in a group --------------------- -.. sample:: Identity/v2/groups/list_users.php +.. sample:: Identity/v3/groups/list_users.php .. refdoc:: OpenStack/Identity/v3/Models/Group.html#method_listUsers Add user to group ----------------- -.. sample:: Identity/v2/groups/add_user.php +.. sample:: Identity/v3/groups/add_user.php .. refdoc:: OpenStack/Identity/v3/Models/Group.html#method_addUser Remove user from group ---------------------- -.. sample:: Identity/v2/groups/remove_user.php +.. sample:: Identity/v3/groups/remove_user.php .. refdoc:: OpenStack/Identity/v3/Models/Group.html#method_removeUser Check user membership in a group -------------------------------- -.. sample:: Identity/v2/groups/check_user_membership.php +.. sample:: Identity/v3/groups/check_user_membership.php .. refdoc:: OpenStack/Identity/v3/Models/Group.html#method_checkMembership diff --git a/doc/services/identity/v3/projects.rst b/doc/services/identity/v3/projects.rst index 55177cf25..1de4f2ab8 100644 --- a/doc/services/identity/v3/projects.rst +++ b/doc/services/identity/v3/projects.rst @@ -4,77 +4,77 @@ Projects Add project ----------- -.. sample:: Identity/v2/projects/add_project.php +.. sample:: Identity/v3/projects/add_project.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_createProject List projects ------------- -.. sample:: Identity/v2/projects/list_projects.php +.. sample:: Identity/v3/projects/list_projects.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_listProjects Show project details -------------------- -.. sample:: Identity/v2/projects/get_project.php +.. sample:: Identity/v3/projects/get_project.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_getProject Update project -------------- -.. sample:: Identity/v2/projects/update_project.php +.. sample:: Identity/v3/projects/update_project.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_update Delete project -------------- -.. sample:: Identity/v2/projects/delete_project.php +.. sample:: Identity/v3/projects/delete_project.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_delete List roles for project user --------------------------- -.. sample:: Identity/v2/projects/list_user_roles.php +.. sample:: Identity/v3/projects/list_user_roles.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_listUserRoles Grant role to project user -------------------------- -.. sample:: Identity/v2/projects/grant_user_role.php +.. sample:: Identity/v3/projects/grant_user_role.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_grantUserRole Check role for project user --------------------------- -.. sample:: Identity/v2/projects/check_user_role.php +.. sample:: Identity/v3/projects/check_user_role.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_checkUserRole Revoke role for project user ---------------------------- -.. sample:: Identity/v2/projects/revoke_user_role.php +.. sample:: Identity/v3/projects/revoke_user_role.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_revokeUserRole List roles for project group ---------------------------- -.. sample:: Identity/v2/projects/list_group_roles.php +.. sample:: Identity/v3/projects/list_group_roles.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_listGroupRoles Grant role to project group --------------------------- -.. sample:: Identity/v2/projects/grant_group_role.php +.. sample:: Identity/v3/projects/grant_group_role.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_grantGroupRole Check role for project group ---------------------------- -.. sample:: Identity/v2/projects/check_group_role.php +.. sample:: Identity/v3/projects/check_group_role.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_checkGroupRole Revoke role for project group ----------------------------- -.. sample:: Identity/v2/projects/revoke_group_role.php +.. sample:: Identity/v3/projects/revoke_group_role.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_revokeGroupRole \ No newline at end of file diff --git a/doc/services/identity/v3/roles.rst b/doc/services/identity/v3/roles.rst index 5baf9ab1b..143dabee3 100644 --- a/doc/services/identity/v3/roles.rst +++ b/doc/services/identity/v3/roles.rst @@ -4,17 +4,17 @@ Roles Add role -------- -.. sample:: Identity/v2/roles/add_role.php +.. sample:: Identity/v3/roles/add_role.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_createRole List roles ---------- -.. sample:: Identity/v2/roles/list_roles.php +.. sample:: Identity/v3/roles/list_roles.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_listRoles List role assignments --------------------- -.. sample:: Identity/v2/roles/list_assignments.php +.. sample:: Identity/v3/roles/list_assignments.php .. refdoc:: OpenStack/Identity/v3/Models/Project.html#method_listRoleAssignments diff --git a/doc/services/identity/v3/services.rst b/doc/services/identity/v3/services.rst index 4ba154af0..39276162e 100644 --- a/doc/services/identity/v3/services.rst +++ b/doc/services/identity/v3/services.rst @@ -4,23 +4,23 @@ Services Add service ----------- -.. sample:: Identity/v2/services/add_service.php +.. sample:: Identity/v3/services/add_service.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_createService List services ------------- -.. sample:: Identity/v2/services/list_services.php +.. sample:: Identity/v3/services/list_services.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_listServices Show service details -------------------- -.. sample:: Identity/v2/services/get_service.php +.. sample:: Identity/v3/services/get_service.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_getService Delete service -------------- -.. sample:: Identity/v2/services/delete_service.php +.. sample:: Identity/v3/services/delete_service.php .. refdoc:: OpenStack/Identity/v3/Models/Service.html#method_delete \ No newline at end of file diff --git a/doc/services/identity/v3/tokens.rst b/doc/services/identity/v3/tokens.rst index 72e8617e9..aff224d19 100644 --- a/doc/services/identity/v3/tokens.rst +++ b/doc/services/identity/v3/tokens.rst @@ -10,38 +10,38 @@ Authenticate (generate) token Generate token with user ID ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. sample:: Identity/v2/tokens/generate_token_with_user_id.php +.. sample:: Identity/v3/tokens/generate_token_with_user_id.php Generate token with username ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. sample:: Identity/v2/tokens/generate_token_with_username.php +.. sample:: Identity/v3/tokens/generate_token_with_username.php Generate token from ID ~~~~~~~~~~~~~~~~~~~~~~ -.. sample:: Identity/v2/tokens/generate_token_from_id.php +.. sample:: Identity/v3/tokens/generate_token_from_id.php Generate token scoped to project ID ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. sample:: Identity/v2/tokens/generate_token_scoped_to_project_id.php +.. sample:: Identity/v3/tokens/generate_token_scoped_to_project_id.php Generate token scoped to project name ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. sample:: Identity/v2/tokens/generate_token_scoped_to_project_name.php +.. sample:: Identity/v3/tokens/generate_token_scoped_to_project_name.php Validate token -------------- -.. sample:: Identity/v2/tokens/validate_token.php +.. sample:: Identity/v3/tokens/validate_token.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_validateToken Revoke token ------------ -.. sample:: Identity/v2/tokens/revoke_token.php +.. sample:: Identity/v3/tokens/revoke_token.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_revokeToken Cache authentication token @@ -66,7 +66,7 @@ expire. Generate token and persist to file ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. sample:: Identity/v2/tokens/export_authentication_token.php +.. sample:: Identity/v3/tokens/export_authentication_token.php For scalability, it is recommended that cached tokens are stored in persistent storage such as memcache or redis instead @@ -75,4 +75,4 @@ of a local file. Initialize Open Stack using cached authentication token ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. sample:: Identity/v2/tokens/use_cached_authentication_token.php +.. sample:: Identity/v3/tokens/use_cached_authentication_token.php diff --git a/doc/services/identity/v3/users.rst b/doc/services/identity/v3/users.rst index db27edbd7..3453c3dc9 100644 --- a/doc/services/identity/v3/users.rst +++ b/doc/services/identity/v3/users.rst @@ -4,41 +4,41 @@ Users Add user -------- -.. sample:: Identity/v2/users/add_user.php +.. sample:: Identity/v3/users/add_user.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_createUser List users ---------- -.. sample:: Identity/v2/users/list_users.php +.. sample:: Identity/v3/users/list_users.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_listUsers Show user details ----------------- -.. sample:: Identity/v2/users/get_user.php +.. sample:: Identity/v3/users/get_user.php .. refdoc:: OpenStack/Identity/v3/Service.html#method_getUser Update user ----------- -.. sample:: Identity/v2/users/update_user.php +.. sample:: Identity/v3/users/update_user.php .. refdoc:: OpenStack/Identity/v3/Models/User.html#method_update Delete user ----------- -.. sample:: Identity/v2/users/delete_user.php +.. sample:: Identity/v3/users/delete_user.php .. refdoc:: OpenStack/Identity/v3/Models/User.html#method_delete List groups for user -------------------- -.. sample:: Identity/v2/users/list_groups.php +.. sample:: Identity/v3/users/list_groups.php .. refdoc:: OpenStack/Identity/v3/Models/User.html#method_listGroups List projects for user ---------------------- -.. sample:: Identity/v2/users/list_projects.php +.. sample:: Identity/v3/users/list_projects.php .. refdoc:: OpenStack/Identity/v3/Models/User.html#method_listProjects diff --git a/doc/services/object-store/v1/account.rst b/doc/services/object-store/v1/account.rst index 972e9f20c..12a4a31ed 100644 --- a/doc/services/object-store/v1/account.rst +++ b/doc/services/object-store/v1/account.rst @@ -6,13 +6,13 @@ Show account details To work with an Object Store account, you must first retrieve an account object like so: -.. sample:: ObjectStore/v2/account/get.php +.. sample:: ObjectStore/v1/account/get.php .. refdoc:: OpenStack/ObjectStore/v1/Service.html#method_getAccount Get account metadata -------------------- -.. sample:: ObjectStore/v2/account/get_metadata.php +.. sample:: ObjectStore/v1/account/get_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Account.html#method_getMetadata Replace all metadata with new values @@ -43,7 +43,7 @@ the metadata of the account will now be: To merge metadata, you must run: -.. sample:: ObjectStore/v2/account/reset_metadata.php +.. sample:: ObjectStore/v1/account/reset_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Account.html#method_resetMetadata Merge new metadata values with existing @@ -75,5 +75,5 @@ the metadata of the account will now be: To reset metadata, you must run: -.. sample:: ObjectStore/v2/account/merge_metadata.php +.. sample:: ObjectStore/v1/account/merge_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Account.html#method_mergeMetadata \ No newline at end of file diff --git a/doc/services/object-store/v1/containers.rst b/doc/services/object-store/v1/containers.rst index fdf742f34..18b2d6567 100644 --- a/doc/services/object-store/v1/containers.rst +++ b/doc/services/object-store/v1/containers.rst @@ -4,7 +4,7 @@ Containers Show details for a container ---------------------------- -.. sample:: ObjectStore/v2/containers/get.php +.. sample:: ObjectStore/v1/containers/get.php .. refdoc:: OpenStack/ObjectStore/v1/Service.html#method_getContainer At this point, the object returned is *empty* because we did not execute a HTTP request to receive the state of the @@ -25,7 +25,7 @@ and all of the local properties will match those of the remote resource. List containers --------------- -.. sample:: ObjectStore/v2/containers/list.php +.. sample:: ObjectStore/v1/containers/list.php .. refdoc:: OpenStack/ObjectStore/v1/Service.html#method_listContainers When listing containers, you must be aware that not *all* information about a container is returned in a collection. @@ -46,7 +46,7 @@ container. Delete container ---------------- -.. sample:: ObjectStore/v2/containers/delete.php +.. sample:: ObjectStore/v1/containers/delete.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_delete The API will only accept DELETE requests on containers when they are empty. If you have a container with any objects @@ -55,7 +55,7 @@ inside, the operation will fail. Get metadata ------------ -.. sample:: ObjectStore/v2/containers/get_metadata.php +.. sample:: ObjectStore/v1/containers/get_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_getMetadata The returned value will be a standard associative array, or hash, containing arbitrary key/value pairs. These will @@ -65,7 +65,7 @@ correspond to the values set either when the container was created, or when a pr Replace all metadata with new values ------------------------------------ -.. sample:: ObjectStore/v2/containers/reset_metadata.php +.. sample:: ObjectStore/v1/containers/reset_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_resetMetadata In order to replace all existing metadata with a set of new values, you can use this operation. Any existing metadata @@ -95,7 +95,7 @@ the metadata of the account will now be: Merge new metadata values with existing --------------------------------------- -.. sample:: ObjectStore/v2/containers/merge_metadata.php +.. sample:: ObjectStore/v1/containers/merge_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_mergeMetadata In order to merge a set of new metadata values with the existing metadata set, you can use this operation. Any existing diff --git a/doc/services/object-store/v1/objects.rst b/doc/services/object-store/v1/objects.rst index a679330e1..7b326b153 100644 --- a/doc/services/object-store/v1/objects.rst +++ b/doc/services/object-store/v1/objects.rst @@ -4,7 +4,7 @@ Objects Show details for an object -------------------------- -.. sample:: ObjectStore/v2/objects/get.php +.. sample:: ObjectStore/v1/objects/get.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_getObject At this point, the object returned is *empty* because we did not execute a HTTP request to receive the state of the @@ -26,7 +26,7 @@ of the object's metadata, will not download the object's content. To do this, se Download an object ------------------ -.. sample:: ObjectStore/v2/objects/download.php +.. sample:: ObjectStore/v1/objects/download.php .. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_download As you will notice, a Stream_ object is returned by this call. For more information about dealing with streams, please @@ -41,7 +41,7 @@ parameter ``$data`` to ``['stream' => true]`` to get the stream before the end o List objects ------------ -.. sample:: ObjectStore/v2/objects/list.php +.. sample:: ObjectStore/v1/objects/list.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_listObjects When listing objects, you must be aware that not *all* information about a container is returned in a collection. @@ -64,13 +64,13 @@ Create an object When creating an object, you can upload its content according to a string representation: -.. sample:: ObjectStore/v2/objects/create.php +.. sample:: ObjectStore/v1/objects/create.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_createObject If that is not optimal or convenient, you can use a stream instead. Any instance of ``\Psr\Http\Message\StreamInterface`` is acceptable. For example, to use a normal Guzzle stream: -.. sample:: ObjectStore/v2/objects/create_from_stream.php +.. sample:: ObjectStore/v1/objects/create_from_stream.php Create a large object (over 5GB) -------------------------------- @@ -84,25 +84,25 @@ uploading, this is what happens under the hood: To upload a DLO, you need to call: -.. sample:: ObjectStore/v2/objects/create_large_object.php +.. sample:: ObjectStore/v1/objects/create_large_object.php .. refdoc:: OpenStack/ObjectStore/v1/Models/Container.html#method_createLargeObject Copy object ----------- -.. sample:: ObjectStore/v2/objects/copy.php +.. sample:: ObjectStore/v1/objects/copy.php .. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_copy Delete object ------------- -.. sample:: ObjectStore/v2/objects/delete.php +.. sample:: ObjectStore/v1/objects/delete.php .. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_delete Get metadata ------------ -.. sample:: ObjectStore/v2/objects/get_metadata.php +.. sample:: ObjectStore/v1/objects/get_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_getMetadata The returned value will be a standard associative array, or hash, containing arbitrary key/value pairs. These will @@ -112,7 +112,7 @@ correspond to the values set either when the object was created, or when a previ Replace all metadata with new values ------------------------------------ -.. sample:: ObjectStore/v2/objects/reset_metadata.php +.. sample:: ObjectStore/v1/objects/reset_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_resetMetadata In order to replace all existing metadata with a set of new values, you can use this operation. Any existing metadata @@ -142,7 +142,7 @@ the metadata of the account will now be: Merge new metadata values with existing --------------------------------------- -.. sample:: ObjectStore/v2/objects/merge_metadata.php +.. sample:: ObjectStore/v1/objects/merge_metadata.php .. refdoc:: OpenStack/ObjectStore/v1/Models/StorageObject.html#method_mergeMetadata In order to merge a set of new metadata values with the existing metadata set, you can use this operation. Any existing