Skip to content

Commit 722bbd6

Browse files
committed
Update README.md with proper terminology
1 parent b440e34 commit 722bbd6

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# netbox-service-mappings
2-
Service Mappings plugin
1+
# netbox-custom-objects
2+
Custom Objects plugin
33

44
1. Add `netbox_custom_objects` to `PLUGINS` in `configuration.py`.
55

@@ -18,33 +18,32 @@ $ ./manage.py migrate
1818

1919
## API
2020

21-
The three relevant models making up the Service Mappings system can be manipulated through CRUD operations using the
22-
standard NetBox API, using endpoints located at: `/api/plugins/service-mappings/`
21+
The three relevant models making up the Custom Objects system can be manipulated through CRUD operations using the
22+
standard NetBox API, using endpoints located at: `/api/plugins/custom-objects/`
2323

2424
```json
2525
{
26-
"mapping-type-fields": "http://127.0.0.1:8000/api/plugins/service-mappings/mapping-type-fields/",
27-
"mapping-types": "http://127.0.0.1:8000/api/plugins/service-mappings/mapping-types/",
28-
"mappings": "http://127.0.0.1:8000/api/plugins/service-mappings/mappings/"
26+
"custom-object-type-fields": "http://127.0.0.1:8000/api/plugins/custom-objects/custom-object-type-fields/",
27+
"custom-object-types": "http://127.0.0.1:8000/api/plugins/custom-objects/custom-object-types/",
28+
"cats": "http://127.0.0.1:8000/api/plugins/custom-objects/cat/"
2929
}
3030
```
3131

32-
### Service Mapping Types
32+
### Custom Object Types
3333

34-
Create a Service Mapping Type with a POST call to `/api/plugins/service-mappings/mapping-types/` using a payload
34+
Create a Custom Object Type with a POST call to `/api/plugins/custom-object/custom-object-types/` using a payload
3535
similar to the following:
3636

3737
```json
3838
{
3939
"name": "My Service Type",
40-
"slug": "my-service-type"
4140
}
4241
```
4342

44-
### Mapping Type Fields
43+
### Custom Object Type Fields
4544

46-
Then define the schema of the Service Mapping Type by creating fields of various types, with POST requests to
47-
`/api/plugins/service-mappings/mapping-type-fields/`:
45+
Then define the schema of the Custom Object Type by creating fields of various types, with POST requests to
46+
`/api/plugins/custom-objects/custom-object-type-fields/`:
4847

4948
```json
5049
{

0 commit comments

Comments
 (0)