[PR #1833] [MERGED] added statement and example for using ForeignKey ID's in write actions in api docs #12273

Closed
opened 2025-12-29 22:20:36 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/1833
Author: @lampwins
Created: 1/22/2018
Status: Merged
Merged: 1/22/2018
Merged by: @jeremystretch

Base: developHead: api-docs


📝 Commits (2)

  • 7341ae0 added statement and exaple for using ForeignKey ID's in write actions
  • 6b50755 fixed duplicate api docs example and grammar

📊 Changes

2 files changed (+5 additions, -4 deletions)

View changed files

📝 docs/api/examples.md (+4 -3)
📝 docs/api/overview.md (+1 -1)

📄 Description

Fixes: #1831

Added a statement in the overview and an example in examples about how to reference related data using ForeignKey ID values in api write actions.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/netbox-community/netbox/pull/1833 **Author:** [@lampwins](https://github.com/lampwins) **Created:** 1/22/2018 **Status:** ✅ Merged **Merged:** 1/22/2018 **Merged by:** [@jeremystretch](https://github.com/jeremystretch) **Base:** `develop` ← **Head:** `api-docs` --- ### 📝 Commits (2) - [`7341ae0`](https://github.com/netbox-community/netbox/commit/7341ae087cf57672e21662b4dba9a22f83275bde) added statement and exaple for using ForeignKey ID's in write actions - [`6b50755`](https://github.com/netbox-community/netbox/commit/6b50755a5a1df04055ca6b21ecc42773cdcfb54d) fixed duplicate api docs example and grammar ### 📊 Changes **2 files changed** (+5 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `docs/api/examples.md` (+4 -3) 📝 `docs/api/overview.md` (+1 -1) </details> ### 📄 Description <!-- Thank you for your interest in contributing to NetBox! Please note that our contribution policy requires that a feature request or bug report be opened for approval prior to filing a pull request. This helps avoid wasting time and effort on something that we might not be able to accept. Please indicate the relevant feature request or bug report below. --> ### Fixes: #1831 <!-- Please include a summary of the proposed changes below. --> Added a statement in the overview and an example in examples about how to reference related data using ForeignKey ID values in api write actions. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 22:20:36 +01:00
adam closed this issue 2025-12-29 22:20:36 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#12273