openstack-api-site

api-site: clean up: spell-check, remove passive voice, method names, and code sample names

Bug #1521244 reported by Diane Fleming on 2015-11-30

This bug affects 1 person

Affects		Status	Importance	Assigned to	Milestone
	openstack-api-site	Fix Released	Low	Diane Fleming	openstack-api-site mitaka

Bug Description

Run spell-check and remove passive voice from API docs.

- Renamed 'api-ref/src/wadls/<name>-api/src/xxx/api_samples'
  to 'api-ref/src/wadls/<name>-api/src/xxx/samples'"
- Renamed code samples using this naming convention:
  <resource>-<action>-request.json or <resource>-<action>-response.json.
  For example, server-create-request.json and server-create-response.json.
- Removed unused code samples
- Made method names consistent throughout - use list<resource> for list
  operations, show<resource> for show operations, and so on.

See original description

Diane Fleming (diane-fleming) on 2015-11-30

Changed in openstack-api-site:
status:	New → Confirmed
importance:	Undecided → Low
assignee:	nobody → Diane Fleming (diane-fleming)
milestone:	none → mitaka

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-11-30: Fix proposed to api-site (master)

Fix proposed to branch: master
Review: https://review.openstack.org/251467

Changed in openstack-api-site:
status:	Confirmed → In Progress

Diane Fleming (diane-fleming) on 2015-12-08

summary:	- api-site: spell-check and remove passive voice + api-site: clean up: spell-check, remove passive voice, method names, and + code sample names
description:	updated

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-08:

Fix proposed to branch: master
Review: https://review.openstack.org/254958

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-10:

Fix proposed to branch: master
Review: https://review.openstack.org/255647

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-10:

Fix proposed to branch: master
Review: https://review.openstack.org/255657

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-12:

Fix proposed to branch: master
Review: https://review.openstack.org/256898

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-12: Change abandoned on api-site (master)

Change abandoned by Diane Fleming (<email address hidden>) on branch: master
Review: https://review.openstack.org/256898
Reason: abandon

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-12: Fix proposed to api-site (master)

Fix proposed to branch: master
Review: https://review.openstack.org/256899

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-12:

Fix proposed to branch: master
Review: https://review.openstack.org/256901

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-12:

Fix proposed to branch: master
Review: https://review.openstack.org/256902

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-12: Fix merged to api-site (master)

#10

Reviewed: https://review.openstack.org/256899
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=1c379a797ebfefaabba22a983f6fbd8c853879f5
Submitter: Jenkins
Branch: master

commit 1c379a797ebfefaabba22a983f6fbd8c853879f5
Author: Diane Fleming <email address hidden>
Date: Fri Dec 11 20:08:30 2015 -0600

Update Orchestration API v1 to spellcheck and make other changes

    - Remove passive voice from api-site
    - Renamed api-ref/src/wadls/orchestration/src/v1/api_samples
      to .../samples
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.

Change-Id: Icbd0e6651615165f3185e048edf02e210ca0759e
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-12:

#11

Reviewed: https://review.openstack.org/256901
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=2999c9829205ae26e8a9b8b37d58d375b5d247d6
Submitter: Jenkins
Branch: master

commit 2999c9829205ae26e8a9b8b37d58d375b5d247d6
Author: Diane Fleming <email address hidden>
Date: Fri Dec 11 20:11:05 2015 -0600

Update Object API v1 to spellcheck and make other changes

    - Remove passive voice from api-site
    - Renamed api-ref/src/wadls/object-api/src/v1/api_samples
      to .../samples
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.

Change-Id: Id2dbc9f35014954bf5b297bd4ebed4d37d0d14f1
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-13: Fix proposed to api-site (master)

#12

Fix proposed to branch: master
Review: https://review.openstack.org/257000

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-13:

#13

Fix proposed to branch: master
Review: https://review.openstack.org/257064

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-14: Fix merged to api-site (master)

#14

Reviewed: https://review.openstack.org/257000
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=85c2de49691c412f367e4e8949fa7150f0b6d27a
Submitter: Jenkins
Branch: master

commit 85c2de49691c412f367e4e8949fa7150f0b6d27a
Author: Diane Fleming <email address hidden>
Date: Sat Dec 12 22:12:30 2015 -0600

Update Image service API v1 and v2 to spellcheck and make other changes

    - Remove passive voice from api-site
    - Renamed api-ref/src/wadls/image-api/src/v1/api_samples
      to .../samples
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.
    - csapi:uuid -> csapi:UUID

Change-Id: I78189bbab4f50b46c4c146abe5e95bede379dda7
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-14:

#15

Reviewed: https://review.openstack.org/254958
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=aedcdf5f24aa270e1058b731e0152ec92fe4990a
Submitter: Jenkins
Branch: master

commit aedcdf5f24aa270e1058b731e0152ec92fe4990a
Author: Diane Fleming <email address hidden>
Date: Tue Dec 8 15:10:11 2015 -0600

Update volume API v1 and v2 to make these changes

    - Spell-check and remove passive voice from api-site
    - Renamed api-ref/src/wadls/volume-api/src/v1/api_samples
      and api-ref/src/wadls/volume-api/src/v2/api_samples
      to .../samples
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.
    - Changed csapi:uuid -> csapi:UUID

Change-Id: I61f33e093c2ec882680d85e9cb3f7c450107496e
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-15: Fix proposed to api-site (master)

#16

Fix proposed to branch: master
Review: https://review.openstack.org/257653

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-15: Fix merged to api-site (master)

#17

Reviewed: https://review.openstack.org/255647
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=744d9640e09103c04f51ec7f3504aac9a46c0841
Submitter: Jenkins
Branch: master

commit 744d9640e09103c04f51ec7f3504aac9a46c0841
Author: Diane Fleming <email address hidden>
Date: Wed Dec 9 20:43:22 2015 -0600

Update telemetry API v2 to make these changes

    - Spell-check and remove passive voice
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.

Change-Id: I1fa3f4c2170f6472ea54575d16b62187b0ac0bb3
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-17:

#18

Reviewed: https://review.openstack.org/255657
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=7624fc7bd95ce1e7e2ee0399a53f57fa15c98933
Submitter: Jenkins
Branch: master

commit 7624fc7bd95ce1e7e2ee0399a53f57fa15c98933
Author: Diane Fleming <email address hidden>
Date: Wed Dec 9 21:28:10 2015 -0600

Update share API with multiple changes

    - Spell-check and remove passive voice
    - Added wadl directory, which contains wadl files
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.
    - change csapi:uuid -> csapi:UUID
    - Add information for time stamps

Change-Id: I437d4707e454501ecd5f00df96e4914a811c4c33
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-17: Fix proposed to api-site (master)

#19

Fix proposed to branch: master
Review: https://review.openstack.org/259181

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-18: Fix merged to api-site (master)

#20

Reviewed: https://review.openstack.org/257653
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=331c5947d8986325623c9061c004276e7cc7a99f
Submitter: Jenkins
Branch: master

commit 331c5947d8986325623c9061c004276e7cc7a99f
Author: Diane Fleming <email address hidden>
Date: Mon Dec 14 20:36:11 2015 -0600

Update Data Processing API to spellcheck and make other changes

    - Remove passive voice from api-site
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.
    - Remove XML code samples
    - Change csapi:uuid -> csapi:UUID

Change-Id: I1cc7043ec8e64b4c4a21d9f462bd2f2ae544d57a
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-18: Fix proposed to api-site (master)

#21

Fix proposed to branch: master
Review: https://review.openstack.org/259549

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-19:

#22

Fix proposed to branch: master
Review: https://review.openstack.org/259704

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-20: Fix merged to api-site (master)

#23

Reviewed: https://review.openstack.org/259181
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=36957db14ab5fa687b4f6d102f4ef9403fbf2eab
Submitter: Jenkins
Branch: master

commit 36957db14ab5fa687b4f6d102f4ef9403fbf2eab
Author: Diane Fleming <email address hidden>
Date: Thu Dec 17 14:59:03 2015 -0600

Update Databases API to spellcheck and make other changes

    - Remove passive voice from api-site
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout
    - use list<resource> for list operations,
      show<resource> for show operations, and so on.
    - Change csapi:uuid -> csapi:UUID

Change-Id: I3e2cbc3454beffd1ed67a377f85cf62bed118c94
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-20:

#24

Reviewed: https://review.openstack.org/256902
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=ad94e2e6a3050b258cb715e660b3ed0e7140d701
Submitter: Jenkins
Branch: master

commit ad94e2e6a3050b258cb715e660b3ed0e7140d701
Author: Diane Fleming <email address hidden>
Date: Fri Dec 11 20:29:41 2015 -0600

Update Networking API v2 to spellcheck and make other changes

    - Remove passive voice from api-site
    - Renamed api-ref/src/wadls/netconn-api/src/v1/api_samples
      to .../samples
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout - use list<resource> for list
      operations, show<resource> for show operations, and so on.
    - Removed xml code samples
    - Change csapi:uuid -> csapi:UUID

    Change-Id: I4d628870017f12ec1a5341e41886259acc0481a8
    Partial-Bug: #1521244
    Closes-Bug: #1525353

Changed in openstack-api-site:
status:	In Progress → Fix Released

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-20:

#25

Reviewed: https://review.openstack.org/259704
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=4c154265c263a6b63abdc340f315f48fd7f77903
Submitter: Jenkins
Branch: master

commit 4c154265c263a6b63abdc340f315f48fd7f77903
Author: Diane Fleming <email address hidden>
Date: Sat Dec 19 10:31:30 2015 -0600

Clustering API fixes

    - Spellcheck and make other changes
    - Remove passive voice from api-site
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
    - Removed unused code samples
    - Made method names consistent throughout
    - use list<resource> for list operations,
      show<resource> for show operations, and so on.
    - Change csapi:uuid -> csapi:UUID

Change-Id: I00bf6f634cc94a57f34610f40280eb9a7ebe372e
Closes-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-20: Change abandoned on api-site (master)

#26

Change abandoned by Diane Fleming (<email address hidden>) on branch: master
Review: https://review.openstack.org/251467
Reason: Abandon - all changes are in other patches

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-21: Fix proposed to api-site (master)

#27

Fix proposed to branch: master
Review: https://review.openstack.org/260086

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-21: Change abandoned on api-site (master)

#28

Change abandoned by Diane Fleming (<email address hidden>) on branch: master
Review: https://review.openstack.org/257064
Reason: moved to https://review.openstack.org/260086

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2015-12-21: Fix merged to api-site (master)

#29

Reviewed: https://review.openstack.org/259549
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=0aa099669cfd60dcc5b8bf09c1b6f516d54033de
Submitter: Jenkins
Branch: master

commit 0aa099669cfd60dcc5b8bf09c1b6f516d54033de
Author: Diane Fleming <email address hidden>
Date: Fri Dec 18 10:59:58 2015 -0600

Update Compute API to spellcheck

    - Remove passive voice from api-site
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout
    - use list<resource> for list operations,
      show<resource> for show operations, and so on.
    - Change csapi:uuid -> csapi:UUID

Change-Id: I88a07329b6d2610c8e3b8dd4a639040832b7582c
Partial-Bug: #1521244

Revision history for this message

OpenStack Infra (hudson-openstack) wrote on 2016-01-04:

#30

Reviewed: https://review.openstack.org/260086
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=3f7ecfafd1abddf2a884b75dc9c4729660691923
Submitter: Jenkins
Branch: master

commit 3f7ecfafd1abddf2a884b75dc9c4729660691923
Author: Diane Fleming <email address hidden>
Date: Mon Dec 21 10:28:34 2015 -0600

Update Identity service API v2 and v3

    - Spellcheck and make other changes
    - Remove passive voice from api-site
    - Renamed api-ref/src/wadls/identity-api/src/v1/api_samples
      to .../samples
    - Renamed code samples using this naming convention:
      <resource>-<action>-request.json or <resource>-<action>-response.json.
      For example, volume-create-request.json and volume-create-response.json.
    - Removed unused code samples
    - Made method names consistent throughout
    - use list<resource> for list operations,
      show<resource> for show operations, and so on.
    - Remove XML code samples
    - Change csapi:uuid -> csapi:UUID

Change-Id: Ia99102d4f5ea681cafce63547324ae3f413baacd
Closes-Bug: #1521244

Report a bug

This report contains Public information

Everyone can see this information.

You are

Subscribing...

Edit bug mail

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.