Skip to content

Commit

Permalink
DOC: formatting updates
Browse files Browse the repository at this point in the history
remove leading / on paths
  • Loading branch information
anish-mudaraddi committed Dec 12, 2024
1 parent 0f54f2d commit 2181c84
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
10 changes: 5 additions & 5 deletions docs/developer_docs/ADDING_NEW_PRESETS.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class QueryPresetsGeneric(QueryPresets):

(Optional) Add alias mappings for the preset - see [Adding Aliases](ADDING_ALIASES.md)

## **2. Edit the corresponding handler class in `/openstackquery/handlers/client_side_handler_<preset-group>.py`.**
## **2. Edit the corresponding handler class in `openstackquery/handlers/client_side_handler_<preset-group>.py`.**

Here you must:
- add a 'client-side' filter function as a method
Expand Down Expand Up @@ -135,15 +135,15 @@ group - you can add one like so:
- it inherits from base class QueryPresets


2. Create new client side handler in `/openstackquery/handlers/client_side_handler_<preset>.py`
- it inherits from base class `ClientSideHandler` - `/openstackquery/handlers/client_side_handler.py`.
2. Create new client side handler in `openstackquery/handlers/client_side_handler_<preset>.py`
- it inherits from base class `ClientSideHandler` - `openstackquery/handlers/client_side_handler.py`.


3. Add your preset as a attribute in query_client_side_handlers dataclass
- located in `/openstackquery/structs/query_client_side_handlers.py`
- located in `openstackquery/structs/query_client_side_handlers.py`


4. Follow steps mentioned above to add new presets to the new preset group class you've created

5. Edit `QueryPresets` type declaration at the bottom of the file `/openstackquery/enums/query_presets.py` and add your new
5. Edit `QueryPresets` type declaration at the bottom of the file `openstackquery/enums/query_presets.py` and add your new
preset class to it
6 changes: 3 additions & 3 deletions docs/developer_docs/ADDING_NEW_QUERIES.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ A new subclass of the `RunnerWrapper` class is required to store how to actually
will also be the place where we can define extra parameters that can be used to fine-tune the query.

To add a Runner Class:
1. Create a new file under `/openstackquery/runners/` called `<resource>_runner.py` replace `<resource>` with openstack resource name you want to query
1. Create a new file under `openstackquery/runners/` called `<resource>_runner.py` replace `<resource>` with openstack resource name you want to query
2. Create the `<resource>Runner` class definition
- class must inherit from `RunnerWrapper` abstract base class and implement abstract methods.

Expand Down Expand Up @@ -116,10 +116,10 @@ see `runners/server_runner.py` to see the implementation details.
A new subclass of the `MappingInterface` class is required to store query mappings.

To add a Mapping Class:
1. Create a new file under `/openstackquery/mappings/` called `<resource>_mapping.py` replace `<resource>` with openstack resource name you want to query
1. Create a new file under `openstackquery/mappings/` called `<resource>_mapping.py` replace `<resource>` with openstack resource name you want to query
2. Create the `<resource>Mapping` class definition
- class must inherit from `MappingInterface` abstract base class and implement abstract methods.
3. Update the enum holding query types `/enums/query_types.py` and add a Enum mapping to this Mapping class.
3. Update the enum holding query types `openstackquery/enums/query_types.py` and add a Enum mapping to this Mapping class.
4. (Optional) Add alias mappings for the query type - see [Adding Aliases](ADDING_ALIASES.md)

### 3a. Set the Prop Enum class
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_docs/OVERVIEW.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ with openstack.
The API must be unchanging - as a developer you will not need to interact with this file unless you are adding a new
API method - e.g. adding a new way to output results

**NOTE: Deleting or Altering an API method requires approval from maintainers and a good reason since it may break
**NOTE: Deleting or altering an API method requires approval from maintainers and a good reason since it may break
existing workflows**


Expand Down

0 comments on commit 2181c84

Please sign in to comment.